/**
 * @(#)RolDAO.java 27-oct-2005
 *
 * Copyright (c) 2005-2010 Psiqueware S.A. de C.V. All Rights Reserved.
 * This software is the proprietary information Psiqueware S.A. de C.V.
 * Use is subject to license terms.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *
 * <br/>Usuario : AngelElectrico
 * <br/>Creaci&oacute;n: 27-oct-2005
 * <br/>
 * <br/>
 * <br/><t5>Cambios :</t5>
 * <br/><b>Fecha | Autor  |  Cambios</b>
 * <br/>27-oct-2005 | <a href = "mailto:AngelElectrico@PsiqueWare.com">Angel El&eacute;ctrico</a> | Creaci&oacute;n del Objeto.
 */

package com.psiqueware.alheli.seguridad.dao;

import com.psiqueware.alheli.dao.AlreadyPersistedObjectException;
import com.psiqueware.alheli.dao.BaseDAO;
import com.psiqueware.alheli.dao.DAOException;
import com.psiqueware.alheli.dao.EnlaceTransaccional;
import com.psiqueware.alheli.dao.NotAPersistedObjectException;
import com.psiqueware.alheli.seguridad.Agrupacion;
import com.psiqueware.alheli.seguridad.Rol;

import java.util.List;

/**
 * Definici&oacute;n gen&eacute;rica para operaciones CRUD para el objeto {@link Rol}
 * Date: 24-oct-2005
 * Time: 17:58:41
 *
 * @author <a href="mailto:psiquetp@gmail.com">Psique</a>
 */

/**
 * Definici&oacute;n gen&eacute;rica para operaciones CRUD para el objeto {@link Rol}.
 * <br/>Paquete Original: com.psiqueware.basico.seguridad.dao
 * <br/>Nombre  Original: RolDAO
 * <br/><a href="RolDAO.java.html"><i>Ver C&oacute;digo Fuente</i> </a>
 *
 * @author <a href="mailto:AngelElectrico@psiqueware.com">Angel El&eacute;ctrico</a>
 * @version Revision: 1.0 24-oct-2005
 */
public interface RolDAO extends BaseDAO
{

    /**
     * Guarda un {@link Rol} en persistencia.
     * Este {@link Rol} no exist&iacute;a previamente en persistencia.
     *
     * @param enlaceTransaccional enlace para hacer at&oacute;micas las transacciones.
     * @param rol
     *
     * @return RolK despu&eacute;s de persistirse.
     *
     * @throws AlreadyPersistedObjectException
     *          en caso de que este {@link Rol} ya existiera en persistencia.
     */
    Rol saveRol(Rol rol, final EnlaceTransaccional enlaceTransaccional) throws AlreadyPersistedObjectException, DAOException;

    /**
     * Actualiza un {@link Rol} en persistencia
     *
     * @param enlaceTransaccional enlace para hacer at&oacute;micas las transacciones.
     * @param rol                 a actualizar
     *
     * @return {@link Rol} actualizado
     *
     * @throws NotAPersistedObjectException en caso de que este {@link Rol} no existiera en persistencia.
     */
    Rol updateRol(Rol rol, final EnlaceTransaccional enlaceTransaccional) throws NotAPersistedObjectException, DAOException;

    /**
     * Devuelve un {@link Rol} a partir de su id.
     *
     * @param enlaceTransaccional enlace para hacer at&oacute;micas las transacciones.
     * @param id                  del {@link Rol} que se busca
     *
     * @return {@link Rol} en caso de encontrarlo, <code>null</code> en otro caso.
     *
     * @throws DAOException si se presenta alg&uacute;n problema.
     */
    Rol findRolPorId(Long id, final EnlaceTransaccional enlaceTransaccional) throws DAOException;

    /**
     * Elimina un {@link Rol} del sistema de persistencia.
     *
     * @param enlaceTransaccional enlace para hacer at&oacute;micas las transacciones.
     * @param rol                 que se pretende elimninar.
     *
     * @throws NotAPersistedObjectException si dicho objeto no exist&iacute;a en persistencia.
     */
    void deleteRol(Rol rol, final EnlaceTransaccional enlaceTransaccional) throws NotAPersistedObjectException, DAOException;

    /**
     * Devuelve un listado de los {@link Rol} que se encuentran en persistencia.
     *
     * @param enlaceTransaccional enlace para hacer at&oacute;micas las transacciones.
     *
     * @return List de objetos {@link Rol}, sin objetos en caso de no haberlos.
     *
     * @throws DAOException si se presenta alg&uacute;n problema.
     */
    List listRol(EnlaceTransaccional enlaceTransaccional) throws DAOException;


    /**
     * Devuelve un listado de los {@link Rol} que se encuentran en la {@link Agrupacion}.
     *
     * @param enlaceTransaccional enlace para hacer at&oacute;micas las transacciones.
     *
     * @return List de objetos {@link Rol}, sin objetos en caso de no haberlos.
     *
     * @throws DAOException si se presenta alg&uacute;n problema.
     */
    List<Rol> listRolPorAgrupacion(final Agrupacion agrupacion,final EnlaceTransaccional enlaceTransaccional)throws DAOException;
}
